Appointment Management API - TMF646

API Request Payload

HTTP query parameter	Example Field Value	Description
fields	N/A	Not used in this API. If this parameter is passed in with any values will be ignored.

HTTP Header Name	Example Field Value	Description
Correlation-ID	c97de875-44fa-4b49-9f3b-015d15a14efe	A GUID to relate requests belonging to the same transaction

HTTP URI	Example Field Value	Description
/appointment		This is the GET list endpoint. It will return to partners a list of appointment collections.

Filters	Example Field Value	Description
/appointment?relatedParty.id=&relatedEntity.id=&relatedEntity.role=&relatedEntity.referredType	id: 123456789 @referredType: BillingAccount	The Billing Account Id This is the GET list endpoint. It will return a partial list of appointment collections that belong to the same BillingAccount. The filter will be added by default when invoked by Appointment Microservice. The BillingAccount used will be extracted from JWT token shared during the Partner authentication process. Note: Number of results are subject to default filtering rules.
/appointment?relatedEntity.id=&relatedEntity.role=&relatedEntity.referredType	id: 54321 @referredType: Ticket	The Trouble Ticket Id It will return the Partner all the appointments for a given Trouble Ticket. Note: results are subject to default filters.
/appointment?relatedEntity.id=&relatedEntity.role=&relatedEntity.referredType	id: 987654 @referredType: Order	The Provisioning Order Id It will return the Partner all the appointments for a given Provisioning Order. Note: results are subject to default filters.
/appointment?offset=	offset: 0	The starting index for set of responses to provide to Partner when requested by client. Pagination will calculate the necessary values in response to HTTP Header X-TOTAL-COUNT and X-TOTAL-PAGES values in the GET list response. Default value if none provided will be 0.
/appointment?limit=	limit: 25 Minimum limit: 1 Maximum limit: 100	Requested number of responses to provide in response requested by client. Pagination will calculate the necessary values in response to HTTP Header X-TOTAL-COUNT and X-TOTAL-PAGES values in the GET list response. Default value if none provided will be 25.

API Response Payload

HTTP Header Name	Example Field Value	Description
X-Correlation-ID	c97ded75-44fa-4b69-9f3b-01d513a41efe	A GUID to relate requests belonging to the same transaction.
X-Total-Count	150	Header representing the total number of resources/records matching the query.
X-Result-Count	25	Header representing the number of records returned in this page.

The response will be an array of representing a collection of resources that match the filter criteria. Details of a single record are shown here:

Payload Field Name	Example Field Value	Description
id	APP1234	Unique identifier of the appointment. A PXC reference.
href	/appointment/{id}	The URI of the resource.
supplierAppointmentId	1234	Extension to the API. Unique identifier for the appointment. A supplier reference when Openreach creates an Aline appointment.
openreachAppointmentId	1234	Extension to the API. Unique identifier for the appointment internally in Openreach Strategic Interface. A Fiber Cable reference.
category	Repair Provision Modify	It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification.
appointmentType	Standard Flexible	Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers.
externalId	432113	A Partner’s reference Id. Part of Standard TMF646 spec.
description	Fix an internet connection problem for a customer	Short free text describing the appointment. Part of Standard TMF646 spec.
creationDate	2025-02-01T14:48:45.071Z	Timestamp of the Appointment creation date.
lastUpdate	2025-02-01T14:48:45.071Z	Timestamp of the last time Appointment was updated.
status	initialised scheduled cancelled failed	Current status of the Appointment when the GET request is issued.
requestedExecutionDate	2025-02-01T14:48:45.071Z	Extension to the API. Timestamp until which appointment transaction is valid and can be used with an order. Same as the reservation date for Openreach appointments.
validFor		Time interval appointment is valid for.
validFor\startDateTime	2025-02-15T08:00:00.000Z	Timestamp of the start time of the appointment. (UTC timestamp)
validFor\endDateTime	2025-02-18T08:00:00.000Z	Timestamp of the end time of the appointment.
relatedEntity	See relatedEntity table	array for AccessCASR contains a AccessCASR and the BillingAccount elements id = <an AccessCASR> role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = <a ProductId> role = relatedProduct @referredType = Product
note	See note table	array
@type	PXCAppointment
@baseType	Appointment